home *** CD-ROM | disk | FTP | other *** search
/ STraTOS 1997 April & May / STraTOS 1 - 1997 April & May.iso / CD01 / INTERNET / SITES / GRAHAM / XA_6B.ZIP / DOCS / USERGUID.TXT < prev   
Encoding:
Text File  |  1996-10-21  |  8.7 KB  |  265 lines
  1. XaAES User Manual
  2. (W)Craig Graham (c_graham@patrol.i-way.co.uk)
  3.  
  4. 1) INSTALLATION
  5. -------------------
  6.  
  7. Installing is pretty easy, just do the following:
  8.  
  9. i) Stick these files all in one directroy:
  10.    xaaes.tos   - The kernal (colour & mono versions are in seperate archives)
  11.    xaaes.cnf   - Like GEM.CNF, but for xaaes.
  12.    logo.prg    - the XaAES logo, (possibly) launched at startup.
  13.    system.rsc  - various GUI elements for the kernal (default menu, alert template, etc)
  14.    bar.app     - Simple Application launcher (like Fvwm's GoodStuff 
  15.                  button bar)
  16.    bar.rsc     - Resource file for the above.
  17.  
  18. ii) Copy the mouse device driver 'moose.xdd' to one of:
  19.     c:\multitos
  20.     c:\mint
  21.     c:\
  22.     Your auto folder
  23.  
  24. iii) Copy these files into the root directory of your boot drive:
  25.    bar\bar.inf
  26.  
  27. iv) If you want a console shell (the xaaes.cnf file is set up to give you one),
  28.    you should edit the xaaes.cnf file so rt runs your fave shell (I use sh, but
  29.    mupfel, etc will work as well).
  30.  
  31. v) Add these lines to your MiNT.CNF file:
  32.  
  33.       cd u:\<path>
  34.       INIT=u:\<path>\xaaes.tos
  35.  
  36.      Alternatively, if you are a bit more of a techie, XaAES will run happily from
  37.      a command line (and let you exit back to it) or as a login shell.
  38.  
  39. Ok, thats it.
  40.  
  41. 1.1) COMMAND LINE ARGUMENTS
  42.  
  43. XaAES has the following command line arguments:
  44.  
  45. 1.1.1) Standard Atari Video Mode Select
  46.  
  47.          -video <mode>
  48.  
  49. Selects the video mode that XaAES will boot into where <mode> is:
  50.  
  51.       2 = 320*200, 16 colour (ST-Low)
  52.       3 = 640*200, 4 colour (ST-Medium)
  53.       4 = 640*400, 2 colour (ST-High)
  54.       6 = 640*480, 16 colour (TT Medium)
  55.       8 = 1280*960, 2 colour (TT High)
  56.       9 = 320*480, 256 colour (TT Low)
  57.  
  58. These numbers are simply the VDI physical workstation id's that
  59. are assigned to each video mode. If you have a strange video card,
  60. use whatever workstation ID your card's driver is assigned to.
  61.  
  62. You should use this if you have an ST/TT - it will work on a falcon
  63. but you will get better performance by using the -fvideo switch 
  64. instead.
  65.  
  66. 1.1.2) Falcon Video Mode Select
  67.  
  68.     -fvideo <modecode>
  69.  
  70. Select a falcon video mode, where <modecode> is a video modecode
  71. as used by the VsetMode() OS call. The format of this is:
  72.  
  73.     BIT    Name    Meaning
  74.     0-2    BPS    Number of bitplanes:
  75.                 000=2colour
  76.                 001=4colour
  77.                 010=16colour
  78.                 011=256colour
  79.                 100=16bits/pixel (True colour)
  80.     3    COL    Number of columns
  81.                 0=40
  82.                 1=80
  83.     4    VGA    Monitor select
  84.                 0=TV mode
  85.                 1=VGA mode
  86.     5    TVSEL    TV standard select
  87.                 0=NTSC
  88.                 1=PAL
  89.     6    OVERSCN    Overscan flag (not valid for VGA)
  90.                 0=don't overscan
  91.                 1=overscan
  92.     7    STMODES    ST Compatibility mode
  93.                 0=Standard VGA video modes
  94.                 1=ST Compatible Video modes
  95.     8    VERTFLAG Vertical mode
  96.                 VGA:
  97.                     0=standard
  98.                     1=line doubling (half res)
  99.                 TV:
  100.                     0=standard
  101.                     1=Interlace (double res!!!)
  102.     9-15    unused
  103.  
  104. For example, 'xaaes -fvideo 26' will select 640*480*16colour VGA mode.
  105.  
  106. This should work with video expanders (it works fine with 
  107. FalconScreen) and with NVDI (I've tried it with NVDI4).
  108.                                  
  109. 2) Using XaAES
  110. -----------------
  111.  
  112. 2.1) Menus
  113.  
  114. Generally XaAES is like GEM, but with a few exceptions. Most notably, menu's are
  115. Mac-style pull down, not GEM style drop down. This means that you've got to click
  116. on a menu title to see the menu, not just point at it.
  117.  
  118. Also, holding down CONTROL and clicking on the menu bar will 'Tear-Away' the menu
  119. bar, allowing you to have several menu's on screen at the same time.
  120.  
  121. 2.2) Typing
  122.  
  123. XaAES can be point-to-type - so keyboard input goes to the window under the mouse and
  124. NOT to the top window. This depends on compile time flags - check the boot message
  125. to see if this feature is active.
  126.  
  127.  
  128. 3) XaAES Keyboard Combo's
  129. ----------------------------
  130.  
  131. There are a couple of keyboard combo's that XaAES uses for itself. These are:
  132.  
  133. CTRL+ALT+TAB     : swaps menu bars, not top windows.
  134. CTRL+ALT+L       : Activate the 'Task Manager' window.
  135. CTRL+ALT+D       : Output a status dump to the debug file
  136. CTRL+ALT+K       : Clean up - search for dead clients that didn't call appl_exit
  137. CTRL+ALT+R       : Attempt to recover control of a hung system - use as a last resort,
  138.                    as this will kill the clients that are blocking the system.
  139. CTRL+ALT+C       : Shutdown immediately, killing all clients.
  140.  
  141. NOTE: CTRL+ALT+D only outputs anything if GENERATE_DIAGS was turned on at
  142. compile time - in the binary distributions released by me (Craig) they will have no
  143. effect as all diagnostics are turned off.
  144.  
  145. 4) SYSTEM MENU
  146. ---------------
  147.  
  148. The XaAES system menu (CTRL+ALT+TAB until you get it) currently contains two useful
  149. options.
  150.  
  151. One is the 'About XaAES...' option which (surprisingly) brings up a nice
  152. little descriptive box.
  153.  
  154. The other (more useful) option is in 'Shutdown'. This will kill all GEM programs
  155. and exit XaAES gracefully. Unlike MultiTOS, if you ran XaAES from a command line
  156. or as a login shell, you will be returned to the command line or login prompt. You
  157. can then re-start XaAES, or do whatever - XaAES can be exitted and restarted as many
  158. times as you like without rebooting the machine.
  159.  
  160. XaAES catches CTRL+ALT+C and CTRL+ALT+\  (SIGINT & SIGQUIT respectively) and executes
  161. the shutdown procedure in response to them, so you should be able to get back to your
  162. command line in most situations.
  163.  
  164. 4.1) TASK MANAGER
  165. ------------------
  166. The 'Process' menu of the XaAES System menu also contains the
  167. 'Task Manager' option. This opens a window with a scrolling list
  168. of current AES client applications. This is not a list of all
  169. MiNT processes, it's only a list of GEM programs.
  170.  
  171. The Task Manager allows you to suspend, resume, kill and launch
  172. GEM programs.
  173.  
  174. The icons next to each list entry represent the app status
  175. (Application awake, Accesory awake, Sleeping/suspended,messages
  176. pending, owns lock, etc).
  177.  
  178. There is a set of icon buttons at the top of the window
  179. (from left to right):
  180.  
  181. o Launch
  182.   Launch a new GEM program. A file selector will prompt you for
  183.   the filename.
  184.  
  185. o Trash
  186.   Kill the task that is selected in the task list.
  187.  
  188. o Sleep
  189.   Put the selected task to sleep. This will hide all it's windows
  190.   and send SIGSTOP to the process to suspend it.
  191.  
  192. o Wake
  193.   Wake up the selected task. This is the opposite of Sleep, and
  194.   will restore all the app's windows (on top, in the order the app
  195.   had them) and send SIGCONT to let the process continue.
  196.  
  197. As previously mentioned, CTRL+ALT+L will also open the Task Manager.  
  198.  
  199. 6) WINDOW SCROLLING
  200. --------------------
  201.  
  202. Scroll bars are extended from the usual GEM style to be similar to WinX's behaviour.
  203. Clicking and dragging the scroll bar with the right hand button will work the same as
  204. normal GEM. Clicking and dragging with the left hand button will do REALTIME/LIVE
  205. scrolling, where the window will update as you move the mouse (not just when you 
  206. release it as in the standard GEM behaviour). This is nice for programs that have
  207. fast window updates, but is annoying for old/slow programs (which is why it's
  208. on a seperate button).
  209.  
  210. 7) THE xaaes.cnf FILE
  211. -----------------------
  212.  
  213. This is a bit like MultiTOS's GEM.CNF file. It's main purpose is to let you auto-launch
  214. programs as XaAES starts up. Generally the syntax of this is supposed to be the same as
  215. Atari's GEM.CNF file
  216.  
  217. It's a simple text file with the following format:
  218.  
  219. i)   '#' is a comment line.
  220. ii)  Commands are not case sensitive (although paths may be, depending on your filesystem).
  221. iii) If a command isn't understood, it gets ignored...
  222. iv)  These commands are currently supported:
  223.  
  224.          run <program> <parameters....>
  225.             Launch a program.
  226.  
  227.          debug <file/device>
  228.             Set debugging output to <file/device> (default is .\debug.list)
  229.  
  230.          clipboard <directory>
  231.             Set the GEM clipboard to be in <directory> (default is c:\clipbrd).
  232.  
  233.          accpath <directory>
  234.             Set the location that XaAES will try to load accessories 
  235.             from (default is c:\).
  236.  
  237. And example xaaes.cnf file (in fact, the one I use) is:
  238.  
  239.    #Craig's Setup
  240.    #---------------
  241.    # Set the default clipboard path
  242.    clipboard c:\clipbrd\
  243.    #
  244.    # Where to load desk accessories from
  245.    accpath c:\
  246.    #
  247.    # Launch toswin (68030 version) to handle TOS programs for me
  248.    run u:\h\sources\aes\sys\toswin30.prg
  249.    #
  250.    # Launch the desktop
  251.    run u:\c\thing\thing.app
  252.    #
  253.    # Set Debugging to go to serial port
  254.    debug u:\dev\ttyb
  255.    #
  256.  
  257. x) Caveats
  258. --------------
  259.  
  260. I've compiled  out most of the diagnostics, but if you get funny messages on
  261. the screen, add the line 'debug \dev\null' to the xaaes.cnf file.
  262.  
  263. Loads of stuff is missing at the moment, don't hassle me - fix it and get back
  264. to me.
  265.